home *** CD-ROM | disk | FTP | other *** search
/ InfoMagic Internet Tools 1993 July / Internet Tools.iso / RockRidge / ip / dns / doc.2.0 / doc.txt < prev    next >
Encoding:
Text File  |  1990-08-22  |  4.9 KB  |  134 lines
  1.  
  2. ##
  3. ##    Distributed with: Doc - Version 2.0 (8/22/90)
  4. ##    USC Information Sciences Institute
  5. ##
  6.  
  7.  
  8. DOC                  UNIX Programmer's Manual               DOC
  9.  
  10.  
  11.  
  12. NAME
  13.      doc - diagnose unhealthy DNS domains
  14.  
  15. SYNOPSIS
  16.      doc [-p][-e][-w][-v][-d] domain_name [parent_domain_name]
  17.  
  18. DESCRIPTION
  19.      Doc is an automated tool for verifying (to an extent) that a
  20.      domain is configured and functioning correctly.
  21.  
  22.      The only required parameter is the valid domain name of an
  23.      existing domain. Example:
  24.  
  25.            doc isi.edu.
  26.  
  27.      If the parent (delegating) domain can be determined simply
  28.      by stripping off the first domain part and subsequent dot from
  29.      the specified domain name, then there is no need to include
  30.      the parent_domain_name parameter.  Examples:
  31.  
  32.            doc isi.edu. edu.               (this is correct)
  33.            doc isi.edu.                    (this works too)
  34.            doc 9.128.in-addr.arpa. arpa.   (this is correct)
  35.            doc 9.128.in-addr.arpa.         (this will NOT work)
  36.  
  37.      In the last (incorrect) example, because there is no parent
  38.      domain specified, 'doc' fills in the optional parent_domain
  39.      parameter, and runs as if you specified:
  40.  
  41.            doc 9.128.in-addr.arpa. 128.in-addr.arpa.
  42.  
  43.      Since, the delegation information for 9.128.in-addr.arpa. is
  44.      not at 128.in-addr.arpa. (rather at arpa.), this run will
  45.      abort, and not report as expected.
  46.  
  47. OPTIONS
  48.  
  49.      -p  Skip testing the information held at delegating
  50.          domain's servers.
  51.  
  52.      The default operation of 'doc' includes testing that all of the
  53.      servers for the delegating (parent) domain agree about the
  54.      delegation information held for the domain in question.  Since
  55.      inconsistencies discovered at this level may or may not indicate
  56.      serious problems, one can choose to skip the parent testing.
  57.      If so, 'doc' uses the first non-authoritative list of NS records
  58.      from a parent domain server as those to direct further queries.
  59.      If all of the parent domain servers are additionally authoritative
  60.      for the domain, the answer from the last one queried is used.
  61.      This may be a useful timesaver if you are regularly checking up
  62.      on a large number of domains.  [See also section FILES USED for
  63.      a similar functionality.]
  64.  
  65.  
  66.      -[ewvd]  Specify the level of verbosity to standard output.
  67.  
  68.      The default mode of operation is to only print to standard output
  69.      a summary of what is discovered.  In addition, errors made in the
  70.      process of testing (i.e. query errors, errors causing 'doc' to
  71.      abort, etc) are noted.
  72.  
  73.      -e  Output comments about errors discovered.
  74.      -w  Output comments about warnings issued.
  75.      -v  Verbose output. Include misc. comments and output
  76.          confirming correct behavior.
  77.      -d  Debug output. Checkpoint current (last) nameserver query.
  78.  
  79.      These output options are cumulative (i.e. -v implies -v -w -e).
  80.  
  81.      NOTE: Parsing is very simple.  All option flags must come before
  82.            the domain names.
  83.  
  84. FILES CREATED
  85.  
  86.      In addition to the standard output, 'doc' produces a log file
  87.      named log.<domain_name>, which it places in the current
  88.      directory.  This file includes all "verbose" level comments,
  89.      followed by the nameserver responses to the queries (in a
  90.      slightly masticated form).
  91.  
  92.      While running, 'doc' creates several temporary files in the
  93.      current directory.  These files have names of the form:
  94.  
  95.             <domain_name>.* 
  96.  
  97. FILES USED
  98.  
  99.      'Doc' expects the auxiliary files: doc1.awk, doc3.awk, and
  100.      doc4.awk to reside in the current working directory.
  101.  
  102.      'Doc' looks for the file DNsrv.<parent_domain_name> in the
  103.      working directory.  If it exists, 'doc' does not make a standard
  104.      query to discover the list of nameservers for the parent domain.
  105.      Rather it queries the list of servers contained in this file to
  106.      obtain delegation information for the domain being tested.  This
  107.      may be useful if one regularly tests a series of domains, all
  108.      with the same delegating zone, where one of the servers in known
  109.      to be foul.  This server would simply be omitted from the the
  110.      DNsrv.* file.
  111.  
  112.      awk, sed & dig (version 2.0 or higher) are expected to be found
  113.      in your normal path.  If not, you may want to alias to the full
  114.      path inside of 'doc' itself.
  115.  
  116.  
  117. DETAILS
  118.      See distribution file INFO, for details of procedure.
  119.  
  120. BUGS
  121.      The current implementation is fairly simple (albeit not pretty),
  122.      so it is not expected to abort unexpectedly.  However, this
  123.      version (2.0) is an initial attempt at automating this task.
  124.      Further development is expected in identifying the appropriate
  125.      queries, analysis, and subsequent conclusions that are made.
  126.      Comments are very much welcome.
  127.  
  128. AUTHOR
  129.      Steve Hotz (hotz@isi.edu)
  130.      Paul Mockapetris (pvm@isi.edu)
  131.  
  132. SEE ALSO
  133.      dig(1),  bind operators guide,  RFCs: 1034,1035,xxxx
  134.